<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_yield_context</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="basic_writable_pipe__rebind_executor/other.html" title="basic_writable_pipe::rebind_executor::other">
<link rel="next" href="basic_yield_context/basic_yield_context.html" title="basic_yield_context::basic_yield_context">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_writable_pipe__rebind_executor/other.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_yield_context/basic_yield_context.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.basic_yield_context"></a><a class="link" href="basic_yield_context.html" title="basic_yield_context">basic_yield_context</a>
</h3></div></div></div>
<p>
        <a class="indexterm" name="boost_asio.indexterm.basic_yield_context"></a>
      </p>
<p>
        A <a class="link" href="../overview/model/completion_tokens.html" title="Completion Tokens">completion
        token</a> that represents the currently executing coroutine.
      </p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <a class="link" href="Executor1.html" title="Executor requirements">Executor</a><span class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">basic_yield_context</span>
</pre>
<h5>
<a name="boost_asio.reference.basic_yield_context.h0"></a>
        <span class="phrase"><a name="boost_asio.reference.basic_yield_context.types"></a></span><a class="link" href="basic_yield_context.html#boost_asio.reference.basic_yield_context.types">Types</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/cancellation_slot_type.html" title="basic_yield_context::cancellation_slot_type"><span class="bold"><strong>cancellation_slot_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The cancellation slot type associated with the yield context.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/executor_type.html" title="basic_yield_context::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The executor type associated with the yield context.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.basic_yield_context.h1"></a>
        <span class="phrase"><a name="boost_asio.reference.basic_yield_context.member_functions"></a></span><a class="link" href="basic_yield_context.html#boost_asio.reference.basic_yield_context.member_functions">Member
        Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/basic_yield_context.html" title="basic_yield_context::basic_yield_context"><span class="bold"><strong>basic_yield_context</strong></span></a> <span class="silver">[constructor]</span>
                </p>
              </td>
<td>
                <p>
                  Construct a yield context from another yield context type.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/cancelled.html" title="basic_yield_context::cancelled"><span class="bold"><strong>cancelled</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Determine whether the current coroutine has been cancelled.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/get_cancellation_slot.html" title="basic_yield_context::get_cancellation_slot"><span class="bold"><strong>get_cancellation_slot</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the cancellation slot associated with the coroutine.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/get_cancellation_state.html" title="basic_yield_context::get_cancellation_state"><span class="bold"><strong>get_cancellation_state</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the cancellation state associated with the coroutine.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/get_executor.html" title="basic_yield_context::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the executor associated with the yield context.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/operator_lb__rb_.html" title="basic_yield_context::operator[]"><span class="bold"><strong>operator[]</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Return a yield context that sets the specified error_code.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/reset_cancellation_state.html" title="basic_yield_context::reset_cancellation_state"><span class="bold"><strong>reset_cancellation_state</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Reset the cancellation state associated with the coroutine.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_yield_context/throw_if_cancelled.html" title="basic_yield_context::throw_if_cancelled"><span class="bold"><strong>throw_if_cancelled</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Determine whether the coroutine throws if trying to suspend when
                  it has been cancelled. <br> <span class="silver"> —</span><br> Set whether the coroutine
                  throws if trying to suspend when it has been cancelled.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<p>
        The <a class="link" href="basic_yield_context.html" title="basic_yield_context"><code class="computeroutput"><span class="identifier">basic_yield_context</span></code></a> class is a completion
        token type that is used to represent the currently executing stackful coroutine.
        A <a class="link" href="basic_yield_context.html" title="basic_yield_context"><code class="computeroutput"><span class="identifier">basic_yield_context</span></code></a> object may be
        passed as a completion token to an asynchronous operation. For example:
      </p>
<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Executor</span><span class="special">&gt;</span>
<span class="keyword">void</span> <span class="identifier">my_coroutine</span><span class="special">(</span><span class="identifier">basic_yield_context</span><span class="special">&lt;</span><span class="identifier">Executor</span><span class="special">&gt;</span> <span class="identifier">yield</span><span class="special">)</span>
<span class="special">{</span>
  <span class="special">...</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">n</span> <span class="special">=</span> <span class="identifier">my_socket</span><span class="special">.</span><span class="identifier">async_read_some</span><span class="special">(</span><span class="identifier">buffer</span><span class="special">,</span> <span class="identifier">yield</span><span class="special">);</span>
  <span class="special">...</span>
<span class="special">}</span>
</pre>
<p>
        The initiating function (async_read_some in the above example) suspends the
        current coroutine. The coroutine is resumed when the asynchronous operation
        completes, and the result of the operation is returned.
      </p>
<h5>
<a name="boost_asio.reference.basic_yield_context.h2"></a>
        <span class="phrase"><a name="boost_asio.reference.basic_yield_context.requirements"></a></span><a class="link" href="basic_yield_context.html#boost_asio.reference.basic_yield_context.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/spawn.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span>None
      </p>
</div>
<div class="copyright-footer">Copyright © 2003-2025 Christopher M.
      Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_writable_pipe__rebind_executor/other.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_yield_context/basic_yield_context.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
